Update site title and meta description for search results - #650
Open
Sachindu-Nethmin wants to merge 1 commit into
Open
Update site title and meta description for search results#650Sachindu-Nethmin wants to merge 1 commit into
Sachindu-Nethmin wants to merge 1 commit into
Conversation
Rename the site title from 'WSO2 Integrator Documentation' to 'WSO2 Integration Platform Documentation' so search engine listings show the current product name. Rewrite the tagline, which Docusaurus emits as the homepage meta description, to name the product and state what the site covers within the ~160 character limit search engines display.
Sachindu-Nethmin
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
September 4, 2026 04:17
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
Sachindu-Nethmin
changed the title
AmilaSamith
added
the
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Resolves #516
Google lists the documentation site under the previous product name. The live homepage currently emits:
The title still says WSO2 Integrator rather than WSO2 Integration Platform, and the description does not name the product or say what the site covers, so it reads poorly as a search snippet.
Goals
Approach
Two values in
en/docusaurus.config.ts:title→WSO2 Integration Platform Documentation. Docusaurus renders this as the<title>suffix on every page, so the rename applies site-wide (homepage becomesHome | WSO2 Integration Platform Documentation).tagline→ rewritten.en/src/pages/index.tsxpassessiteConfig.taglinetoLayoutas the homepagedescription, so this value becomes the<meta name="description">andog:description. The new text is 138 characters, within the ~160 characters search engines display. The tagline is not rendered as visible page text anywhere, so this is a metadata-only change.rel="canonical"(https://wso2.com/integration-platform/docs/) andsitemap.xmlwere checked on the deployed site and are already correct, so no change was needed there.Not addressed by this PR
The third point in the issue — older MI and BI docs outranking these docs for
WSO2 Integrator docs— is not fixed here. This site's canonical tags are already correct, so the remaining work is on the MI/BI documentation sites (canonical or redirect rules pointing at the current docs) and is outside this repository. Happy to open a separate issue to track it.User stories
N/A
Release note
Update the documentation site title and homepage meta description to use the WSO2 Integration Platform name.
Documentation
N/A. This changes the documentation site's own metadata.
Training
N/A
Certification
N/A
Marketing
N/A. Note that this changes user-visible text in search results and browser tabs, so it may warrant a review by documentation@wso2.com.
Automation tests
N/A
N/A. Covered by the existing PR build check.
Security checks
Samples
N/A
Related PRs
N/A
Migrations (if applicable)
N/A
Test environment
N/A. Configuration-only change; verified against the deployed site's emitted
<head>tags and covered by the PR build check.Learning
Confirmed how the values flow to the rendered markup before changing them:
titleis applied by Docusaurus as the global<title>suffix, andtaglinereaches the homepage meta description via the explicitdescription={siteConfig.tagline}prop inen/src/pages/index.tsxrather than automatically.